Quickstart

2024-06-02 07:18| 来源: 网络整理| 查看: 265

Usage露

CTRL-Z exposes a CLI object to hook into your project, for example:

backup/cli.py露 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20#!/usr/bin/env python import os import sys from ctrl_z import cli def setup(): # Here you should ensure that your Django project is properly added to # ``sys.path``, and any other setup is done (loading ``.env`` for # example) so that settings can be imported in ctrl-z and django # initialized. pass # assign the setup function to call cli.setup = setup if __name__ == '__main__': # specify which config file to use cli(config_file='/path/to/backup/config.yml')

Once the setup around the CLI is done, you can use it.

CLI help露

At any time, you can get the CLI help:

python backup/cli.py --help CTRL-Z 0.1.2 - Backup and recovery tool usage: cli.py [-h] [--config-file CONFIG_FILE] [--base-dir BASE_DIR] {generate_config,backup,restore} ... CTRL-Z CLI positional arguments: {generate_config,backup,restore} Sub commands generate_config Generate a config file from the default config backup Create a backup restore Restore a backup optional arguments: -h, --help show this help message and exit --config-file CONFIG_FILE Config file to use --base-dir BASE_DIR Base directory override Generate a config file露

CTRL-Z ships with a default config file that you can use as a starting point.

python backup/cli.py generate_config

Command options:

-o, --output-file: (relative or absolute) path to write the config to. Defaults to stdout.

See Configuration for detailed config options documentation.

Generate a backup露 python backup/cli.py backup

By default, database AND file directories (such as settings.MEDIA_ROOT) are backed up.

Command options:

--no-db, --no-database: do not dump the databases --skip-db: aliases (the key in settings.DATABASES) to skip dumping for. Useful if you have a multi-db setup and only the default is important, for example. Use multiple times for each alias to skip. --no-files: do not backup the (uploaded) files (e.g. settings.MEDIA_ROOT) Restore a backup露 python backup/cli.py restore /var/backups/2018-06-27-daily/

Restore the backup at the specified path.

Command options:

--no-db, --no-database: do not restore the databases --skip-db: aliases (the key in settings.DATABASES) to skip restoring for. Useful if you have a multi-db setup and only the default is important, for example. Use multiple times for each alias to skip. --no-files: do not restore the (uploaded) files (e.g. settings.MEDIA_ROOT) --db-name: convenient for loading a different source database name into the target environment. Syntax: alias:name, for example default:project_staging. Dump files are saved with the database name in the file name, so this allows you to refer to that. Can be used multiple times for multi-db setups. --db-host: convenient for loading a different source database host into the target environment. Syntax: alias:host, for example default:localhost. Dump files are saved with the database host in the file name, so this allows you to refer to that. Can be used multiple times for multi-db setups. --db-port: convenient for loading a different source database port into the target environment. Syntax: alias:port, for example default:5432. Dump files are saved with the database port in the file name, so this allows you to refer to that. Can be used multiple times for multi-db setups.

【本文地址】

公司简介

联系我们